<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Subject-Observer: WheelSpinSensor Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">Subject-Observer
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.2 -->
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('class_wheel_spin_sensor.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_wheel_spin_sensor-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">WheelSpinSensor Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>This class simulates a wheelspinsensor.  
 <a href="class_wheel_spin_sensor.html#details">More...</a></p>

<p><code>#include &lt;WheelSpinSensor.h&gt;</code></p>
<div class="dynheader">
Inheritance diagram for WheelSpinSensor:</div>
<div class="dyncontent">
 <div class="center">
  <img src="class_wheel_spin_sensor.png" usemap="#WheelSpinSensor_map" alt=""/>
  <map id="WheelSpinSensor_map" name="WheelSpinSensor_map">
<area href="class_object.html" title="Common Baseclass for all other classes." alt="Object" shape="rect" coords="0,0,112,24"/>
</map>
 </div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a2bedfd267c03d20a206b67705f1646e2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_wheel_spin_sensor.html#a2bedfd267c03d20a206b67705f1646e2">WheelSpinSensor</a> (std::string filename)</td></tr>
<tr class="memdesc:a2bedfd267c03d20a206b67705f1646e2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Ctor of the <a class="el" href="class_wheel_spin_sensor.html" title="This class simulates a wheelspinsensor.">WheelSpinSensor</a> class.  <a href="#a2bedfd267c03d20a206b67705f1646e2"></a><br/></td></tr>
<tr class="separator:a2bedfd267c03d20a206b67705f1646e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a793dd2f9babe379c0e93f1e9032af210"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_wheel_spin_sensor.html#a793dd2f9babe379c0e93f1e9032af210">~WheelSpinSensor</a> ()</td></tr>
<tr class="memdesc:a793dd2f9babe379c0e93f1e9032af210"><td class="mdescLeft">&#160;</td><td class="mdescRight">DTor of the <a class="el" href="class_wheel_spin_sensor.html" title="This class simulates a wheelspinsensor.">WheelSpinSensor</a> class.  <a href="#a793dd2f9babe379c0e93f1e9032af210"></a><br/></td></tr>
<tr class="separator:a793dd2f9babe379c0e93f1e9032af210"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a197a4fcb1876c36ac44dc46d87572db4"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_wheel_spin_sensor.html#a197a4fcb1876c36ac44dc46d87572db4">GetRevolutions</a> ()</td></tr>
<tr class="memdesc:a197a4fcb1876c36ac44dc46d87572db4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read the revolutions from a file and return it.  <a href="#a197a4fcb1876c36ac44dc46d87572db4"></a><br/></td></tr>
<tr class="separator:a197a4fcb1876c36ac44dc46d87572db4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_object"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_object')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_object.html">Object</a></td></tr>
<tr class="memitem:aa3e791419d84c4c346ef9499513b8e00 inherit pub_methods_class_object"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_object.html#aa3e791419d84c4c346ef9499513b8e00">~Object</a> ()</td></tr>
<tr class="memdesc:aa3e791419d84c4c346ef9499513b8e00 inherit pub_methods_class_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">DTor of the <a class="el" href="class_object.html" title="Common Baseclass for all other classes.">Object</a> class.  <a href="#aa3e791419d84c4c346ef9499513b8e00"></a><br/></td></tr>
<tr class="separator:aa3e791419d84c4c346ef9499513b8e00 inherit pub_methods_class_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_static_methods_class_object"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_class_object')"><img src="closed.png" alt="-"/>&#160;Static Public Member Functions inherited from <a class="el" href="class_object.html">Object</a></td></tr>
<tr class="memitem:a86a84ed2d1207e5f8827165ac2941106 inherit pub_static_methods_class_object"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_object.html#a86a84ed2d1207e5f8827165ac2941106">deleteObject</a> (<a class="el" href="class_object.html">Object</a> *obj)</td></tr>
<tr class="memdesc:a86a84ed2d1207e5f8827165ac2941106 inherit pub_static_methods_class_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Frees the memory used by obj.  <a href="#a86a84ed2d1207e5f8827165ac2941106"></a><br/></td></tr>
<tr class="separator:a86a84ed2d1207e5f8827165ac2941106 inherit pub_static_methods_class_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This class simulates a wheelspinsensor. </p>
<p>The class <a class="el" href="class_wheel_spin_sensor.html" title="This class simulates a wheelspinsensor.">WheelSpinSensor</a> simulates a Wheelspinsensor. It sequentially reads a file which contains values for the wheelspin. Should be called every 500 ms via the Process function of the <a class="el" href="class_p_k_w.html" title="Represents a PKW which is a specialisation of an Automobile.">PKW</a>.</p>
<dl class="section author"><dt>Author</dt><dd>Thomas Pfeiffer </dd></dl>
<dl class="section date"><dt>Date</dt><dd>13.11.2012 </dd></dl>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a2bedfd267c03d20a206b67705f1646e2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">WheelSpinSensor::WheelSpinSensor </td>
          <td>(</td>
          <td class="paramtype">std::string&#160;</td>
          <td class="paramname"><em>filename</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Ctor of the <a class="el" href="class_wheel_spin_sensor.html" title="This class simulates a wheelspinsensor.">WheelSpinSensor</a> class. </p>
<p>The only CTor of the <a class="el" href="class_wheel_spin_sensor.html" title="This class simulates a wheelspinsensor.">WheelSpinSensor</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">filename</td><td>The filename of the file which contains the sensor data (revolutions). </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a793dd2f9babe379c0e93f1e9032af210"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">WheelSpinSensor::~WheelSpinSensor </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>DTor of the <a class="el" href="class_wheel_spin_sensor.html" title="This class simulates a wheelspinsensor.">WheelSpinSensor</a> class. </p>
<p>The destructor free the resources used by the object. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a197a4fcb1876c36ac44dc46d87572db4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t WheelSpinSensor::GetRevolutions </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Read the revolutions from a file and return it. </p>
<p>The function <a class="el" href="class_wheel_spin_sensor.html#a197a4fcb1876c36ac44dc46d87572db4" title="Read the revolutions from a file and return it.">GetRevolutions()</a> reads a value from a file and returns it. The read value is the current revolution of the <a class="el" href="class_p_k_w.html" title="Represents a PKW which is a specialisation of an Automobile.">PKW</a>. </p>
<dl class="section return"><dt>Returns</dt><dd>0 if EOF reached. </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
  <table class="exception">
    <tr><td class="paramname">std::exception</td><td>when the file can't be opened or when the file has a faulty format (e.g. contains letters). </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="class_wheel_spin_sensor.html">WheelSpinSensor</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.2 </li>
  </ul>
</div>
</body>
</html>
